Amiga Tools 1

home *** CD-ROM | disk | FTP | other *** search

/ Amiga Tools 1 / Amiga Tools.iso / egs-tools / egs_dev-disk / egsdocs / egs.doc < prev next >

Wrap

Text File | 1994-06-06 | 72.9 KB | 2,838 lines

TABLE OF CONTENTS egs.library/--background-- egs.library/--bitmap driver-- egs.library/--display driver-- egs.library/--oop in egs-- egs.library/--video routing-- egs.library/E_ActivateAmigaScreen egs.library/E_ActivateEGSScreen egs.library/E_AddClassMethod egs.library/E_AddMethod egs.library/E_AddMonitorSpec egs.library/E_AddPublicClass egs.library/E_AddPublicVideoNode egs.library/E_AddScreenMode egs.library/E_AddVideoLink egs.library/E_AllocBitMap egs.library/E_AllocBitMapClass egs.library/E_AllocBitMapFrame egs.library/E_AllocEMem egs.library/E_CanDisplayOnMonitor egs.library/E_ChangeMonitorSpecTagList egs.library/E_ChangeScreenParamTagList egs.library/E_ChangeScreenSpecTagList egs.library/E_ClearBitMap egs.library/E_CloseScreen egs.library/E_CreateEMemPool egs.library/E_CreateMonitorSpecTagList egs.library/E_CreateObject egs.library/E_CreateObjectMsg egs.library/E_CreateScreenParamTagList egs.library/E_CreateScreenSpecTagList egs.library/E_CreateSubClass egs.library/E_CrossMouseBorder egs.library/E_DefinePublicObject egs.library/E_DeleteEMemPool egs.library/E_DeleteMonitorSpec egs.library/E_DeleteObject egs.library/E_DeleteScreenParam egs.library/E_DeleteScreenSpec egs.library/E_Dispatch egs.library/E_DispatchClass egs.library/E_DisposeBitMap egs.library/E_DisposeBitMapFrame egs.library/E_FindPublicVideoNode egs.library/E_FlipMap egs.library/E_FreeEMem egs.library/E_GetClassMethod egs.library/E_GetHardInfo egs.library/E_GetRGB8 egs.library/E_GetRGB8CM egs.library/E_GetRealTimings egs.library/E_GetSymName egs.library/E_GetSymbol egs.library/E_LoadDriver egs.library/E_LoadMonitorPrefs egs.library/E_LockEGSVideo egs.library/E_ModifyEDCMP egs.library/E_ModifyMouse egs.library/E_MouseOff egs.library/E_MouseOffRect egs.library/E_MouseOn egs.library/E_MoveMouse egs.library/E_NewMapType egs.library/E_ObtainClass egs.library/E_ObtainMonitorSpec egs.library/E_ObtainObject egs.library/E_ObtainObjectClass egs.library/E_ObtainPublicClass egs.library/E_ObtainPublicObject egs.library/E_ObtainScreenSpec egs.library/E_OldWaitTOF egs.library/E_OpenScreen egs.library/E_OpenScreenTagList egs.library/E_ReleaseClass egs.library/E_ReleaseMonitorSpec egs.library/E_ReleasePublicObject egs.library/E_ReleaseScreenSpec egs.library/E_ReloadPrefs egs.library/E_RemMonitorSpec egs.library/E_RemVideoLink egs.library/E_RenameMonitorSpec egs.library/E_ResetMouseExcept egs.library/E_SaveMonitorPrefs egs.library/E_SaveMonitorSpec egs.library/E_ScreenToBack egs.library/E_ScreenToFront egs.library/E_SendEGSMsg egs.library/E_SetMouseExcept egs.library/E_SetRGB8 egs.library/E_SetRGB8CM egs.library/E_SetUserFocus egs.library/E_UnlockEGSVideo egs.library/E_WaitTOF egs.library/E_WhichMonitor egs.library/E_WhichScreen egs.library/E_isSubClass egs.library/E_isSubType egs.library/--background-- egs.library/--background-- EGS is a fully retargetable 24 bit window system for the Amiga. It consists of trditional amiga shared libraries and objectoriented elements like classes and objects. The egs.library is the lowest library based level of egs. Everything below is a driver and may only be used for board developer specific goals. This library represents the graphic and event base of the EGS system. It also serves as the lowest level of the resource manager. The third important feature of it is the basic support of oop for egs. The EGS library manages two important graphic resources, the "BitMap" and the "Screen". A "BitMap" is an structure that abstracts from the actual way in which graphics data is structured and stored for a specific display hardware. EGS supports several standard bitmap types, like "Chunky" or "Planar" and also customer defined bitmap types. A programm may access a bitmap in two different ways. First and better, using the rendering functions of egs. This will work on any bitmap type or depth. Second, by direct accessing the bitmap data. This is only permited for standard bitmap types (except of the drivers themself), and may include some arbitration routines. A "Screen" is an abstract handle for a displayable bitmap. And also the basic way to revceive user input. An "EScreen" (the egs.library style screen) combines a bitmap, a mouse cursor a message port for user input, a colormap (for non true color modes) and the display driver data, describing the displaymode. egs.library/--bitmap driver-- egs.library/--bitmap driver-- egs.library/--display driver-- egs.library/--display driver-- egs.library/--oop in egs-- egs.library/--oop in egs-- EGS uses objectorientet technics in several ways. The EGS object system is a partially typed, class based object system, including polymorphism, late binding inheritance and message based communication. It is an transparent extension to existing structures. An EGS object is a traditional structure, extended by a pointer to its class at offset minus four. An EGS class is an object itself, and has its own class called a metaclass (same as in Smalltalk). The rootclass of the system is the objectclass ("Object.class"). The metaclass of the rootclass and the ancestor of all metaclasses is the classclass ("Class.class"). The class of the classclass is the objectclass. New classes can be created by inheriting of an existing class. The new class may be modified, to fit its new requirements. Every class except of the objectclass has exactly one direct superclass (single inheritance). The EGS object system is based on symbols. These symbols are a unique representation of a string. They can be converted to and from string by library functions. If two strings are equal (character by character), they yield the same symbol. These symbols contain a hash value for their represented string, and are used for dictionaries and method dispatching. Objects communicate by sending messages to other objects. These are no exec messages, instead they are dispatched into method calls for the receiver. The type of the message (e.g. WritePixel) is defined by a symbol. The dispatching is done by the EGS library. A class contains a dictionary of methods. The EGS library looks up the symbol on a method dispatch and branches to the selected method. No method dispatching has to be done by user code. The method dictionaries are self optimizing by reorganizing entries is in the hash chain. Every method slot consists of two elements, the function pointer to the routine itself and an user specific data element, for method data (e.g. could be used for global data basepointers like a4). A method is called with a pointer to the message in a2, and the method specific data in a1. _All_ registers are scratch _except_ a4 and a7. Some EGS structures offer a different way for method dispatching. This is appropriate, if the base type of the object is sure (like E_EBitMap in egsblit), and high performance is requiered. These structures maintain a jump table which may be directly used to reach a method. If you use this shortcut, make sure, that your registers are scratch, and the message is fully initialized (especially the self field which is normally initialized by the dispatcher). egs.library/--video routing-- egs.library/--video routing-- egs.library/E_ActivateAmigaScreen egs.library/E_ActivateAmigaScreen NAME E_ActivateAmigaScreen -- Activate the original amiga screen. SYNOPSIS E_ActivateAmigaScreen() void E_ActivateAmigaScreen(void) FUNCTION Activates the original amiga screen, moving it to front if both sources have the same output. Also reactivates the amiga mouse, and redirects input to it. This function has no effect if the amiga screen is allready active. INPUTS RESULT SEE ALSO egs.library/E_ActivateEGSScreen egs.library/E_ActivateEGSScreen NAME E_ActivateEGSScreen -- Activates the EGS screen. SYNOPSIS E_ActivateEGSScreen() void E_ActivateEGSScreen(void) FUNCTION Activates the EGS screen, moving it to front if both sources have the same output. Also activates the EGS mouse, and redirects input (mouse, keyboard, diskchanges etc.) to it. This function has no effect, if no EGS screen is open, or the EGS screen is already active. INPUTS RESULT SEE ALSO egs.library/E_AddClassMethod egs.library/E_AddClassMethod NAME E_AddClassMethod -- Add or change a classmethod to a class SYNOPSIS E_AddClassMethod(class, name, call, data) A0 D0 A1 A2 void E_AddClassMethod(E_EGSClassPtr, E_Symbol, E_EGSCall, APTR) FUNCTION Add a class method to an existing class. The method may then be invoked by any user of that class. You should not change classes that you did not create. Class methods are not methods of the objects of a class, they are the methods of the class itself. Using class methods you can change the behaviour of a class. You can also use this function to change an existing method (inherited or not). You can use this call to change the "addMethod" method of your class and implement a static typed changing scheme like in the E_EGSBitMapClass. The method code will be called like any EGSMethod, with a pointer to the message in A2 and your private date in A1. INPUTS class - the class you want to change name - a symbol giving the name of the method you want to work on. call - a pointer to the function that implements the method data - any data you need for your method. You get this back in A1 when your function is called. RESULT SEE ALSO E_AddMethod(), E_CreateSubClass(), E_Dispatch(), E_DispatchClass(), E_GetClassMethod() egs.library/E_AddMethod egs.library/E_AddMethod NAME E_AddMethod -- Add or change a method of a class SYNOPSIS E_AddMethod(class, name, call, data) A0 D0 A1 A2 void E_AddMethod(E_EGSClassPtr, E_Symbol, E_EGSCall, APTR) FUNCTION Add or change a method to an existing class. The method may then be invoked by any user of an object (including existing ones) of this class. The method will normaly be invoked by a call to E_Dispatch(). The call will be included in the class's dispatching table. If the class implements a static typed caching scheme, your method will also be put into the class container. The method code will be called with a pointer to the message structure in A2 and your private data in A1. All registers except of A4 and A7 are scratch inside your method code. INPUTS class - the class you want to change name - a symbol giving the name of the method you want to work on. call - a pointer to the function that implements the method data - any data you need for your method. You get this back in A1 when your function is called. RESULT SEE ALSO E_AddClassMethod(), E_CreateSubClass(), E_Dispatch(), E_DispatchClass() egs.library/E_AddMonitorSpec egs.library/E_AddMonitorSpec NAME E_AddMonitorSpec -- Add a monitor spec. to a display dirver SYNOPSIS E_AddMonitorSpec(driver, monitor) A0 A1 void E_AddMonitorSpec(E_DisplayDriverPtr, E_MonitorSpecPtr) FUNCTION Adds a monitor specification to a display driver. It has to be fully initialized and valid at this moment. You may change it afterwards using the appropriate functions. The driver will be informed to change its screenmodes. A list of all public available screenmodes can be found in the E_HardInfo structure. INPUTS driver - the display driver you want to change monitor - a valid monitor specification RESULT SEE ALSO E_CreateMonitorSpecTagList(), E_RemMonitorSpec(), E_ChangeMonitorSpecTagList(), E_DeleteMonitorSpec(), E_CreateScreenSpecTagList(), E_DeleteScreenSpec() egs.library/E_AddPublicClass egs.library/E_AddPublicClass NAME E_AddPublicClass -- Add a public class to the system SYNOPSIS E_AddPublicClass(class, name) A0 D0 BOOL E_AddPublicClass(E_EGSClassPtr, E_Symbol) FUNCTION Adds a public class to the system. The class is then available to other class users/implementors. You should not change a class that has been made public. Public classes are vital to the system, and can not be replaced. If you need a place for replaceable public classes, this is what public objects are for (all classes in EGS are also public objects). Examples for public classes are basic bitmap classes (like "ChunkyMap8.class") or basic system classes (like "Blanker.class"). Classes that are only good for your own purpose should be kept private. Classes that may be replaced by other classes should be stored and accessed as public objects. A class may be both a public class and a public object (like the Blanker.class). INPUTS class - the class you want to make public name - a symbol giving the public name of this class RESULT TRUE, if the call succeeded, FALSE if the call failed, this happens if a class with this name is already public in the system. BUGS Public classes are currently not removeable. They will stay in the system for ever (or better titl the next boot). SEE ALSO E_ObtainPublicClass(), E_DefinePublicObject(), E_ObtainPublicObject(), E_ReleaseClass(), E_ReleasePublicObject() egs.library/E_AddPublicVideoNode egs.library/E_AddPublicVideoNode NAME E_AddPublicVideoNode -- Make a video node public to the system SYNOPSIS E_AddPublicVideoNode(node) A0 BOOL E_AddPublicVideoNode(E_VideoNodePtr) FUNCTION Adds a video node to the pool of public video nodes. These should only be done for long time nodes, like monitors or displaydrivers. Screens and other private nodes should be kept private. You may use public objects to share them between aplications. INPUTS node - the node you want to make public. The name field of the node has to be initialized with the nodes name. RESULT TRUE, if the call succeeded, FALSE if the call failed, this happens if a node with this name is already public in the system. BUGS A public video node can currently not be removed. SEE ALSO E_DefinePublicObject(), E_FindPublicVideoNode() egs.library/E_AddScreenMode egs.library/E_AddScreenMode NAME E_AddScreenMode -- add a screenmode to the system list SYNOPSIS E_AddScreenMode(mode) A0 BOOL E_AddScreenMode(E_ScreenModePtr) FUNCTION Adds a screenmode to the list of system screenmodes. This call is typically called by a displaydriver that is not based on the egs display database. The screenmode must be valid and correct initialized. It may be extended with private driver data. The driver will get the same pointer back, when it is invoked to open a screen. Drivers that use the EGS display database should not call this function. They should build and add their screenmodes by a call to E_LoadMonitorPrefs(). INPUTS mode - an initialized E_ScreenMode structure. At least this fields have to be initialized: node->Name, Horiz, Vert, Depths, Driver. All param fields have to be either NULL, or should point to a valid screen param structure. RESULT TRUE, if the call succeeded, FALSE if the call failed, this happens if a screenmode with this name is already public in the system. SEE ALSO E_LoadMonitorPrefs(), E_GetHardInfo(), E_OpenScreen() egs.library/E_AddVideoLink egs.library/E_AddVideoLink NAME E_AddVideoLink -- Add a link between two video nodes SYNOPSIS E_AddVideoLink(from, to) A0 A1 void E_AddVideoLink(E_VideoNodePtr, E_VideoNodePtr) FUNCTION Connects two video nodes with a directed link. This is typically done by the EGSConfig program during startup. It is also used to add newly created screens to the screen multiplexer of a display driver. INPUTS from - the node where the video signal comes from. This node has to be able to suply video. to - the node where the video signal goes to. This node has to be able to receive video. RESULT BUGS Should have a return value for success indication. SEE ALSO E_RemVideoLink(), E_AddPublicVideoNode(), E_WhichMonitor(), E_WhichScreen() egs.library/E_AllocBitMap egs.library/E_AllocBitMap NAME E_AllocBitMap -- Allocates and initializes bitmap structure and planes... SYNOPSIS E_AllocBitMap(width, height, depth, type, flags, friend) D0 D1 D2 D3 D4 A0 E_EBitMapPtr E_AllocBitMap(UWORD, UWORD, UWORD, ULONG, ULONG, E_EBitMapPtr) FUNCTION Allocates display or clipping memory. Creates a bitmap structure and allocates the needed memory. The structure is initialized. The bitmaps are not cleared. The function allocates display or clipping (in fast mem) memory, depending on the type. If a friend bitmap is supplied the library determines the type out of this bitmap. The EGS memory management regards graphics memory as an important resource. Therefore memory segments are moved in their address location when necessary in order to gain big consecutive segments. To prevent memory from being tugged away right under your feet, memory must be locked before access. For this topic refer to E_EMemNode structure in the includes. If the system is equipped with virtuell memory, the function may allocate huge clipping areas in the virtuell memory area. WARNING You should not pass a friend bitmap, if you want to allocate a mask bitmap or a 24 bit bitmap. Their may be no bitmap class of the same type with the requiered depth. So for all normal purposes, you should give friend->Depth as the depth argument, if you allocate a friend bitmap. If you allocate with a friend bitmap it is not save to assume that the resulting bitmap is the same as the friend. It will typically be a bitmap of the same family, but not of the same class. NOTE If you call this function from a task (not a DOS process) it may fail, although the requiered bitmap class may be available from disk. If you want to be sure, that you can allocate a bitmap from a task, you should obtain the bitmap class from a process and call E_AllocBitMapClass() from within the task. INPUTS width, height - Dimensions of required bitmap depth - Depth of required bitmap type - Type of bitmap (which format etc.) flags - properties of the bitmap (fastmem/graphicsmem etc.) friend - friend bitmap or NULL. The class of a friend bitmap determines the type of the created bitmap. If you need a bitmap for double buffering, you should give the screens bitmap as friend, and allocate with E_EB_DISPLAYABLE. If you need a bitmap for clipping, caching or prerendering, you will also allocate a friend bitmap. RESULT Inititialized bitmap if successfull, NULL else. SEE ALSO E_AllocBitMapClass(), E_AllocBitMapFrame(), E_DisposeBitMap() egs.library/E_AllocBitMapClass egs.library/E_AllocBitMapClass NAME E_AllocBitMapClass -- Allocate a bitmap of a specific class SYNOPSIS E_AllocBitMapClass(width, height, flags, class) D0 D1 D2 A0 E_EBitMapPtr E_AllocBitMapClass(UWORD, UWORD, ULONG, E_EGSClassPtr) FUNCTION Allocates a bitmap structure and associated memory for a given bitmap class. This is the best way, to get a bitmap of the type you want. WARNING You might get a different bitmap than the one you ordered, depening on the flags you used. INPUTS width - width of the bitmap height - height of it flags - properties of the bitmap class - the class you want to allocate a bitmap for you RESULT Inititialized bitmap if successfull, NULL else. SEE ALSO E_AllocBitMap(), E_AllocBitMapFrame(), E_DisposeBitMap() egs.library/E_AllocBitMapFrame egs.library/E_AllocBitMapFrame NAME E_AllocBitMapFrame -- Allocate a bitmap structure SYNOPSIS E_AllocBitMapFrame(class, w, h, flags) A0 D0 D1 d2 E_EBitMapPtr E_AllocBitMapFrame(E_EBitMapClassPtr, WORD, WORD, ULONG) FUNCTION Allocates a bitmap structure of a specific class. No memory is allocated and only simple initilaisation is done. You have to include the plane memory yourself. This function is typically called for two purposes. First bitmap class implementors will call this to allocate the bitmap structure for them. And second this call is usefull to build a bitmap from already existing data. WARNING You should only use this call if you really know what you are doing. Do not start rendering into this bitmap unless you supplyed the requiered memory. You have to free this bitmap structure with E_DisposeBitMapFrame() not E_DisposeBitMap() INPUTS class - the class you want the bitmap to be of w - the width of the bitmap h - the height of the bitmap flags - some flags RESULT A partially initialized bitmap structure or NULL. You have to at lease "BytesPerRow" and the apropriate memory pointer. SEE ALSO E_DisposeBitMapFrame(), E_AllocBitMap(), E_AllocBitMapClass() egs.library/E_AllocEMem egs.library/E_AllocEMem NAME E_AllocEMem -- allocate memory from an EGS memory pool SYNOPSIS E_AllocEMem(pool, mem, size) A0 A1 D0 BOOL E_AllocEMem(E_EMemPoolPtr, E_EMemPtr, LONG) FUNCTION Attempts to allocate memory from an EGS memory pool. And fills a supplied structure with its location and size. EGS memory pools differ from exec memory pools in the ability to move memory areas to gain more consecutive free space. This function is typically used by a display driver implementor to allocate memory for display bitmaps. WARNING During accesses to the allocated memory, a lock counter has to be incremented in the memory node, to forbid movement of this piece. When this lock is zero the pointer to the actual memory may change at any moment. INPUTS pool - the memory pool you want to allocate from mem - the memory node you want to control the piece of allocated memory size - the size of the requiered memory RESULT TRUE if the call succeeded, FALSE if there could no memory area of the requiered size could be found or created. SEE ALSO E_FreeEMem(), E_CreateEMemPool(), E_DeleteEMemPool(), E_AllocBitMap() egs.library/E_CanDisplayOnMonitor egs.library/E_CanDisplayOnMonitor NAME E_CanDisplayOnMonitor -- test if a screen can be display on a monitor SYNOPSIS E_CanDisplayOnMonitor(scr, mon) A0 A1 BOOL E_CanDisplayOnMonitor(E_EScreenPtr, E_MonitorPtr) FUNCTION Tests if a screen could be displayed on a specific monitor if it would be ordered to do so. This call works even if the screen is not currently displayed. INPUTS scr - the screen you want to test. mon - the monitor where the screen could apear RESULT TRUE if the screen could be display on the monitor, FALSE else SEE ALSO E_WhichScreen(), E_WhichMonitor() egs.library/E_ChangeMonitorSpecTagList egs.library/E_ChangeMonitorSpecTagList NAME E_ChangeMonitorSpecTagList -- change a monitor spec SYNOPSIS E_ChangeMonitorSpecTagList(moni, Tags) A0 A1 void E_ChangeMonitorSpecTagList(E_MonitorSpecPtr, APTR) FUNCTION Changes the properties of a monitor specification. INPUTS moni - the monitor spec you want to change Tags - tags describing the properties you want to change (see "includes/egs/egs.h" E_MST_... for valid tags). RESULT SEE ALSO E_CreateMonitorSpecTagList(), E_CreateScreenSpecTagList(), E_DeleteMonitorSpec(), E_SaveMonitorSpec() egs.library/E_ChangeScreenParamTagList egs.library/E_ChangeScreenParamTagList NAME E_ChangeScreenParamTagList -- change a screen param structure SYNOPSIS E_ChangeScreenParamTagList(param, tags) A0 A1 void E_ChangeScreenParamTagList(E_ScreenParamPtr, APTR) FUNCTION Changes properties of a screen param structure. This will have immediate effect, if a screen with this params is currently displayed. INPUTS param - the screen param structure you want to change tags - tags describing the properties you want to change (see "includes/egs/egs.h" E_SPT... for valid tags). RESULT SEE ALSO E_CreateScreenParamTagList(), E_DeleteScreenParam(), E_ChangeScreenSpecTagList() egs.library/E_ChangeScreenSpecTagList egs.library/E_ChangeScreenSpecTagList NAME E_ChangeScreenSpecTagList -- changes a screen specifiaction SYNOPSIS E_ChangeScreenSpecTagList(spec, tags) A0 A1 void E_ChangeScreenSpecTagList(E_ScreenSpecPtr, APTR) FUNCTION Changes the properties of a screen specification. This will have no immediate effect. INPUTS spec - the screen spec structure you want to change tags - tags describing the properties you want to change (see "includes/egs/egs.h" E_SSPT_... vor valid tags). RESULT SEE ALSO E_CreateScreenSpecTags(), E_DeleteScreenSpec(), E_CreateScreenParamTags() egs.library/E_ClearBitMap egs.library/E_ClearBitMap NAME E_ClearBitMap -- Clears a bitmap SYNOPSIS E_ClearBitMap(map) A0 void E_ClearBitMap(E_EBitMapPtr) FUNCTION Clears a bitmap by filling with zero (normaly black). This will normaly result in a rectangle fill for most bitmap classes. But if some hardware implements a a flush clear (like some VRam parts do) this function will be much faster. INPUTS map - bitmap which to clear RESULT SEE ALSO egs.library/E_CloseScreen egs.library/E_CloseScreen NAME E_CloseScreen -- Close a screen SYNOPSIS E_CloseScreen(scr) A0 void E_CloseScreen(E_EScreenPtr) FUNCTION Closes a screen, which has been opened with E_OpenScreen. Frees all resources like memory, ports, signals etc. If this screen was the last screen on the monitor, the software automagically switches back to an other monitor. After you closed the screen you may not use any friend bitmaps of the screens bitmap anymore, as they may share common parameters. If you used this screen for double buffering with E_FlipMap, the close will not free the initial screen bitmap, it will free the bitmap that is currently associated with the screen. WARNING Do not try to close an EI_Screen, or the E_EScreen associated with it. Use EI_CloseScreen for these screens. INPUTS scr - Screen which to close RESULT SEE ALSO E_OpenScreen(), EI_CloseScreen(), E_FlipMap() egs.library/E_CreateEMemPool egs.library/E_CreateEMemPool NAME E_CreateEMemPool -- create an EGS memory pool SYNOPSIS E_CreateEMemPool(pos, size) A0 D0 E_EMemPoolPtr E_CreateEMemPool(APTR, LONG) FUNCTION Creates an EGS memory pool. These memory pools differ from the commodore memory pools in the fact, that memory may be moved around to gain larger segments. The memory is intended for bitmaps. The memory is partitioned in pieces of 4 KBytes, so this is the minimum size you can allocate. This function is intended for driver implementors only. INPUTS pos - the address of the first byte of memory to be used in the memory pool size - the size of the memory to be used in the memory pool RESULT Returns an opaque handle to the memory pool. This function has to be passed as an argument all allocations in this pool. SEE ALSO E_AllocEMem(), E_FreeEMem(), E_DeleteEMemPool() egs.library/E_CreateMonitorSpecTagList egs.library/E_CreateMonitorSpecTagList NAME E_CreateMonitorSpecTagList -- creates an monitor specification SYNOPSIS E_CreateMonitorSpecTagList(name, Tags) A0 A1 E_MonitorSpecPtr E_CreateMonitorSpecTagList(char *, APTR) FUNCTION Creates and initializes a monitor spec structure. The monitor spec becomes immediately available to E_ObtainMonitorSpec(). INPUTS name - the name of the monitor spec Tags - additional information for the monitor RESULT An initialized monitor spec structure, or NULL if failed SEE ALSO E_ChangeMonitorSpec(), E_DeleteMonitorSpec(), E_CreateScreenSpec() egs.library/E_CreateObject egs.library/E_CreateObject NAME E_CreateObject -- create an EGS object SYNOPSIS E_CreateObject(class) A0 APTR E_CreateObject(E_EGSClassPtr) FUNCTION Creates an EGS object with a standard creation message. The create method of the class will be invoked to create the object. If the class needs more information for creation, the appropriate call would be to E_CreateObjectMsg(). The create method differs in one way from many object oriented languages, as it is not a classmethod, but a normal objectmethod. You should not call the create method on your own, better use this function. The reason for this cludge is, that it makes it possible to change the creation method of the class (the method the class is created itself), without the need of a meta/meta class. The object can be deleted by sending an delete message or by a call to E_DeleteObject(), which will send the message for you. INPUTS class - the class, you want an object of RESULT a pointer to the newly created object or NULL. SEE ALSO E_CreateObjectMsg(), E_DeleteObject(), E_DispatchClass(), E_Dispatch() egs.library/E_CreateObjectMsg egs.library/E_CreateObjectMsg NAME E_CreateObjectMsg -- create an object with arguments SYNOPSIS E_CreateObjectMsg(class, msg) A0 A1 E_EGSObjectPtr E_CreateObjectMsg(E_EGSClassPtr, E_CreateMsgPtr) FUNCTION This function does actually the same as E_CreateObject(), except that it gives you the ability, to pass your own creation message. This is usefull for classes, that need further informations to create an object. INPUTS class - the class you want an object of msg - an (extended) creation message RESULT a pointer to the newly create object of NULL SEE ALSO E_CreateObject(), E_DeleteObject(), E_DispatchClass(), E_Dispatch() egs.library/E_CreateScreenParamTagList egs.library/E_CreateScreenParamTagList NAME E_CreateScreenParamTagList -- create a screen parameter SYNOPSIS E_CreateScreenParamTagList(spec, tags) A0 A1 E_ScreenParamPtr E_CreateScreenParamTagList(E_ScreenSpecPtr, APTR) FUNCTION Creates an screen parameter to a given screen spec. A screen spec may have any number of parameters, a display driver will simply select the best one (highest pixel clock) for a given color depth. INPUTS spec - the ruleing screen spec tags - tags defining the screen param RESULT a pointer to the screen param structure or NULL SEE ALSO E_DeleteScreenParam(), E_ChangeScreenParamTags(), E_ChangeScreeSpec() egs.library/E_CreateScreenSpecTagList egs.library/E_CreateScreenSpecTagList NAME E_CreateScreenSpecTagList -- create a screen spec SYNOPSIS E_CreateScreenSpecTagList(moni, tags) A0 A1 E_ScreenSpecPtr E_CreateScreenSpecTagList(E_MonitorSpecPtr, APTR) FUNCTION Creates a screen spec to a given monitor spec. A monitor spec may have any number of screen specs attached. The screen spec initially has no screen param. You may add screen params to it with E_CreateScreenParamTags(). INPUTS moni - the ruleing monitor spec tags - tags defining the screen spec RESULT a pointer to the screen spec structure or NULL SEE ALSO E_DeleteScreenSpec(), E_ChangeScreenSpecTags(), E_CreateScreenParam() egs.library/E_CreateSubClass egs.library/E_CreateSubClass NAME E_CreateSubClass -- creates a subclass of an existing class SYNOPSIS E_CreateSubClass(super, objectSize, classSize, methods, data) A0 D0 D1 A1 A2 E_EGSClassPtr E_CreateSubClass(E_EGSClassPtr, LONG, LONG, E_MethodListPtr, APTR) FUNCTION Creates, initializes and modifies a subclass to a given class. This call calls the createSubClass method of the class, so you can even modify sub class creation. The sub class is then yours. To get rid of it just call E_ReleaseClass(). You may specify all or some new/change methods you want to put into this class. All non modified methods are inherited from the superclass. You can also change the methods later using E_AddMethod(). INPUTS super - the class you want a child of objectSize - the size of the objects of the new subclass classSize - the size of the subclass structure itself. If you don't want to change the class structure, just pass null in here. methods - an array of method description for the methods you want to change. data - the common data for all new method calls. RESULT a freshly created subclass of the superclass or NULL if failed SEE ALSO E_ReleaseClass(), E_ObtainPublicClass(), E_AddMethod(), E_AddClassMethod() egs.library/E_CrossMouseBorder egs.library/E_CrossMouseBorder NAME E_CrossMouseBorder -- cross the border with the mouse cursor SYNOPSIS E_CrossMouseBorder(from, direction) A0 D0 BOOL E_CrossMouseBorder(E_EScreenPtr, ULONG) FUNCTION INPUTS from - direction - RESULT BUGS This function should be private ??? SEE ALSO egs.library/E_DefinePublicObject egs.library/E_DefinePublicObject NAME E_DefinePublicObject -- define a public object SYNOPSIS E_DefinePublicObject(obj, name) A0 D0 void E_DefinePublicObject(E_PublicEGSObjectPtr, E_Symbol) FUNCTION Makes an object available to the public. The object is obtained by the call, so you can release the object, if you do not need it anymore. If the object is remove from the public dictionary, it will be released and potentially deleted. You may only put subclasses of public object class into the public dictionary. All classes are subclasses of public object class. INPUTS obj - the object you want to make public name - a symbol giving the name of the object. RESULT SEE ALSO E_ReleasePublicObject(), E_AddPublicClass(), E_ObtainPublicObject() egs.library/E_DeleteEMemPool egs.library/E_DeleteEMemPool NAME E_DeleteEMemPool -- delete an EGS memory pool SYNOPSIS E_DeleteEMemPool(pool) A0 void E_DeleteEMemPool(E_EMemPoolPtr) FUNCTION Deletes an EGS memory pool. You may not allocate or free any memory of this pool anymore. This function is usefull for display driver implementors only. INPUTS pool - the pool to delete RESULT SEE ALSO E_CreateEMemPool(), E_AllocEMem(), E_FreeEMem() egs.library/E_DeleteMonitorSpec egs.library/E_DeleteMonitorSpec NAME E_DeleteMonitorSpec -- delete a monitor specification. SYNOPSIS E_DeleteMonitorSpec(moni) A0 void E_DeleteMonitorSpec(E_MonitorSpecPtr) FUNCTION Deletes (or at least attempts to) a monitor spec from memory and/or disk. The monitor spec may still reside in memory after this call, if it is currently obtained, but it will not be available to E_ObtainMonitorSpec() from then on. If a monitor spec is deleted all associated screen spec and screen param structures will be deleted too. INPUTS moni - the monitor spec to delete RESULT SEE ALSO E_CreateMoniorSpec(), E_ObtainMonitoSpec(), E_ReleaseMonitorSpec() egs.library/E_DeleteObject egs.library/E_DeleteObject NAME E_DeleteObject -- delete an EGS object SYNOPSIS E_DeleteObject(obj) A0 void E_DeleteObject(E_EGSObjectPtr) FUNCTION This is the normal way to delete a private EGS object. The call to delete a public object is E_ReleasePublicObject(). This function will invoke the delete method of the object. This will normaly result in the destruction of the object. INPUTS obj - the object to delete RESULT SEE ALSO E_CreateObject(), E_CreateObjectMsg(), E_ReleaseObject() egs.library/E_DeleteScreenParam egs.library/E_DeleteScreenParam NAME E_DeleteScreenParam -- delete a screen param struct SYNOPSIS E_DeleteScreenParam(param) A0 void E_DeleteScreenParam(E_ScreenParamPtr) FUNCTION Removes and deletes a screen param struct. The structure will be in memory until it is not used anymore. INPUTS param - the screen param to delete RESULT SEE ALSO E_DeleteScreenSpec(), E_CreateScreenParam(), E_ChangeScreenParam() egs.library/E_DeleteScreenSpec egs.library/E_DeleteScreenSpec NAME E_DeleteScreenSpec -- delete a screen spec structure SYNOPSIS E_DeleteScreenSpec(spec) A0 void E_DeleteScreenSpec(E_ScreenSpecPtr) FUNCTION Removes and deletes a screen spec structure. All associated screen param structures will also be deleted INPUTS spec - the screen spec structure to delete RESULT SEE ALSO E_CreateScreenSpec(), E_DeleteMonitorSpec(), E_DeleteScreenParam() egs.library/E_Dispatch egs.library/E_Dispatch NAME E_Dispatch -- invoke a method SYNOPSIS E_Dispatch(obj, name, msg) A0 D0 A2 BOOL E_Dispatch(E_EGSObjectPtr, E_Symbol, E_EGSObjMsgPtr) FUNCTION This is the standard way to send a message to an EGS object. This is no exec message sent, it is just a method lookup and a function call. The message structure will be further initialized by writing the method name and self fields. INPUTS obj - the object to receive your message name - the symbol giving the methods name msg - a partially initialized message structure. It depends on the type of message you want to send to the object. RESULT TRUE if the message was implemented in the objects class, FALSE if not SEE ALSO E_DispatchClass(), E_AddMethod() egs.library/E_DispatchClass egs.library/E_DispatchClass NAME E_DispatchClass -- statically invoke a method SYNOPSIS E_DispatchClass(class, name, msg) A0 D0 A2 BOOL E_DispatchClass(E_EGSClassPtr, E_Symbol, E_EGSObjMsgPtr) FUNCTION This is the standard way to forward a message to the static superclass of an method. The method lookup is done in the specified class, instead of the objects class. This is usefull to call a method of the static superclass of a method. WARNING You may not call this function with an other class than a direct superclass of the objects class. INPUTS class - the static superclass name - a symbol defining the name of the method msg - a full initialized message structure RESULT TRUE if the method was implemented in the class, FALSE else SEE ALSO E_Dispatch(), E_AddMethod(), E_CreateSubClass() egs.library/E_DisposeBitMap egs.library/E_DisposeBitMap NAME E_DisposeBitMap -- Free the memory, used by a bitmap SYNOPSIS E_DisposeBitMap(map) A0 void E_DisposeBitMap(E_EBitMapPtr) FUNCTION Returns the memory of a bitmap back to the free memory pool. This should be done with all allocated bitmaps (for exception see E_FlipMap()). WARNING You may call this for bitmaps that where allocated using E_AllocBitMap() or E_AllocBitMapClass(), not for bitmaps that where allocated using E_AllocBitMapFrame(). INPUTS map - bitmap to free RESULT SEE ALSO E_AllocBitMap(), E_DisposeBitMapFrame() egs.library/E_DisposeBitMapFrame egs.library/E_DisposeBitMapFrame NAME E_DisposeBitMapFrame -- dispose a bit map frame SYNOPSIS E_DisposeBitMapFrame(map) A0 void E_DisposeBitMapFrame(E_EBitMapPtr) FUNCTION Frees the memory of a bitmap frame. This will not free the actual image memory. You may call this function only for bitmaps that you allocated using E_AllocBitMapFrame(). INPUTS map - the bitmap frame to dispose RESULT SEE ALSO E_AllocBitMapFrame(), E_AllocBitMap(), E_DisposeBitMap() egs.library/E_FindPublicVideoNode egs.library/E_FindPublicVideoNode NAME E_FindPublicVideoNode -- find a public video node SYNOPSIS E_FindPublicVideoNode(name) A0 E_VideoNodePtr E_FindPublicVideoNode(char *) FUNCTION Searches the video node list for a public node with the given name. INPUTS name - the name of the wanted video node. RESULT a pointert to the public video node, or NULL when none was found SEE ALSO E_AddPublicVideoNode() egs.library/E_FlipMap egs.library/E_FlipMap NAME E_FlipMap -- Show double buffered bitmap SYNOPSIS E_FlipMap(scr, map) A0 A1 E_EBitMapPtr E_FlipMap(E_EScreenPtr, E_EBitMapPtr) FUNCTION Swaps the bitmaps of a screen with a bitmap. This can be used for double buffering. The new map is then linked to the screen, the old bitmap is returned. For double buffering, open a screen, and allocate a bitmap with same dimensions as screens bitmap of display memory. Then render into this bitmap. Then flip the bitmaps and assign the result of E_FlipMap() to your bitmap pointer. Now render in this map and so on. This function attaches the new bitmap to the screen, and releases the old one, so you have to free the old one at the programms end, not your new bitmap (except if you reflip). You will have no problems, if you assign the functions result to your own bitmap pointer, that previously pointed to the new bitmap. The change of the bitmaps will happen when the next frame starts. To make sure, that the change happened, you should call E_WaitTOF(). INPUTS scr - screen for double buffering map - back bitmap, which to show RESULT the previous bitmap of the screen, now that one, which can not be seen BUGS Should get a better way to inform the caller that the flip happened. SEE ALSO E_AllocBitMap(), E_CloseScreen() egs.library/E_FreeEMem egs.library/E_FreeEMem NAME E_FreeEMem -- frees memory that was allocated with E_AllocEMem SYNOPSIS E_FreeEMem(pool, mem) A0 A1 void E_FreeEMem(E_EMemPoolPtr, E_EMemPtr) FUNCTION Gives memory that was allocated using E_AllocEMem() back to the memory pool. INPUTS pool - the pool the memory was taken from mem - the mem node associated to the memory RESULT SEE ALSO E_AllocEMem(), E_CreateEMemPool(), E_DeleteEMemPool() egs.library/E_GetClassMethod egs.library/E_GetClassMethod NAME E_GetClassMethod -- get a method of a class SYNOPSIS E_GetClassMethod(class, sym, method) A0 D0 A1 BOOL E_GetClassMethod(E_EGSClassPtr, E_Symbol, struct E_EGSMethod) FUNCTION Tests if a class implements a specific method, and if so fills the method structure with a copy of its implementation (the pointer to the function and the private data field). INPUTS class - the class to look in sym - a symbol defining the method method - a method container RESULT TRUE when the method is implemented, FALSE else SEE ALSO E_AddMethod(), E_CreateSubClass(), E_Dispatch() egs.library/E_GetHardInfo egs.library/E_GetHardInfo NAME E_GetHardInfo -- Get information about graphicscard SYNOPSIS E_GetHardInfo() E_HardInfoPtr E_GetHardInfo(void) FUNCTION Retrieves information about the current system, including possible screen modes. NOTE Several fields of the hard info structure are outdated, and not valid anymore. Check in the includes. INPUTS RESULT Pointer to a hardinfo structure. The contents of the structure may not be changed !!! SEE ALSO egs.library/E_GetRGB8 egs.library/E_GetRGB8 NAME E_GetRGB8 -- Get RGB value of a clut register SYNOPSIS E_GetRGB8(scr, reg) A0 D0 ULONG E_GetRGB8(E_EScreenPtr, WORD) FUNCTION Returns the RGB value of an entry in the color look up table of a screen. The colors is coded in an ULONG as RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx. The result can be casted into en E_CluEntry struct. INPUTS scr - pointer to the screen reg - number of the colorregister, use only valid entries, depending on the screens depth RESULT the inquiered color as an 8x3 bit RGB value. SEE ALSO E_SetRGB8(), E_GetRGB8CM(), E_SetRGB8CM() egs.library/E_GetRGB8CM egs.library/E_GetRGB8CM NAME E_GetRGB8CM -- Get several RGB values. SYNOPSIS E_GetRGB8CM(scr, colors, start, num) A0 A1 D0 D1 void E_GetRGB8CM(E_EScreenPtr, E_CLUPtr, WORD, WORD) FUNCTION Copies a part of a screens clut into a buffer. Make sure you have enough buffer memory in your color table for this function. INPUTS colors - pointer to buffer start - first register in screens clut num - number of colors to transfer RESULT SEE ALSO E_GetRGB8(), E_SetRGB8(), E_SetRGB8CM() egs.library/E_GetRealTimings egs.library/E_GetRealTimings NAME E_GetRealTimings -- calculates the effective sync timings SYNOPSIS E_GetRealTimings(driver, param, real) A0 A1 A2 void E_GetRealTimings(E_DisplayDriverPtr, E_ScreenParamPtr, E_ScreenParamPtr) FUNCTION Calculates the effecting sync timings for a driver and a screen param. Most drivers only support a limited number of pixel frequencys, and can control sync timings only in multiples of some base units. So the actual timings may vary from the requiered timings. INPUTS driver - the driver to ask for the sync timings param - the specified screen parameters real - the actual screen parameters RESULT SEE ALSO E_CreateScreenParam(), E_ChangeScreenParam() egs.library/E_GetSymName egs.library/E_GetSymName NAME E_GetSymName -- get the string a symbol represents SYNOPSIS E_GetSymName(sym) D0 char * E_GetSymName(E_Symbol) FUNCTION Looks for the textual representation of a symbol. INPUTS sym - the symbol to look for RESULT a pointer to the string defined by the symbol, or NULL if the symbol is invalid. SEE ALSO E_GetSymbol() egs.library/E_GetSymbol egs.library/E_GetSymbol NAME E_GetSymbol -- get a symbol associated to a string SYNOPSIS E_GetSymbol(str) A0 E_Symbol E_GetSymbol(char *) FUNCTION This function is the main entry to the global name space handler. Every string is associated with a symbol. If you pass two times a string with the same value, you will get the same symbol. INPUTS str - the source string RESULT the symbol defining the string SEE ALSO E_GetSymName() egs.library/E_LoadDriver egs.library/E_LoadDriver NAME E_LoadDriver -- load an EGS driver SYNOPSIS E_LoadDriver(name) A0 BOOL E_LoadDriver(char *) FUNCTION Loads an EGS driver into memory, and initiates it. An EGS driver is a library with no associated functions. It is initialized in the normal way. A driver makes its functionality available to the system by adding (one or more) puplic objects or classes. Examples for drivers are display drivers, blankers or the intuition/workbench patch. INPUTS name - the full file name of the driver RESULT TRUE if the driver was installed correct, FALSE else SEE ALSO E_AddPublicClass(), E_DefinePublicObject() egs.library/E_LoadMonitorPrefs egs.library/E_LoadMonitorPrefs NAME E_LoadMonitorPrefs -- load and build a drivers screenmodes SYNOPSIS E_LoadMonitorPrefs(driver) A0 void E_LoadMonitorPrefs(E_DisplayDriverPtr) FUNCTION Loads the monitor definitions for a display driver and builds the drivers screenmodes with data of the EGS display database. INPUTS driver - the driver to get prefs for RESULT SEE ALSO E_AddMonitorSpec(), E_RemMonitorSpec() egs.library/E_LockEGSVideo egs.library/E_LockEGSVideo NAME E_LockEGSVideo -- lock the EGS display system SYNOPSIS E_LockEGSVideo() void E_LockEGSVideo(void) FUNCTION Locks the EGS display system. This is needed if you parse through the lists of the hardinfo structure, or play heavy with the EGS display database. Each call to E_LockEGSVideo() must have a related call to E_UnlockEGSVideo(). When the EGS display system is locked, the system is more or less dead. INPUTS RESULT SEE ALSO E_UnlockEGSVideo() egs.library/E_ModifyEDCMP egs.library/E_ModifyEDCMP NAME E_ModifyEDCMP -- Modifies the EDCMP flags of a screen SYNOPSIS E_ModifyEDCMP(scr, flags) A0 D0 void E_ModifyEDCMP(E_EScreenPtr, UWORD) FUNCTION Sets the EDCMP flags of a screen. Opens or closes the screens port if needed. For user defined ports the port should be removed before clearing all flags. INPUTS flags - new set of edcmpflags RESULT SEE ALSO E_OpenScreen(), E_CloseScreen() egs.library/E_ModifyMouse egs.library/E_ModifyMouse NAME E_ModifyMouse -- Modify the shape of a screens mouse. SYNOPSIS E_ModifyMouse(scr, mouse) A0 A1 void E_ModifyMouse(E_EScreenPtr, E_EMousePtr) FUNCTION Sets a new shape for the screens mouse pointer. This is the only legal way to change the mouse. You may read the "mouse" field in the E_Screen structure, to get the standard mouse, but you may not alter this field except using this function. If the screen is the actual displayed, the change takes place immediately. As in EI_Screens, the mouse is attached to a window not to a screen, you must use the function in the egsintui.library if working with windows. INPUTS mouse - initialized mouse structure This structure may not be discarded RESULT SEE ALSO egs.library/E_MouseOff egs.library/E_MouseOff NAME E_MouseOff -- Switch softwaremouse off SYNOPSIS E_MouseOff(scr) A0 void E_MouseOff(E_EScreenPtr) FUNCTION On graphics board which do not have a hardware cursor the software mouse has to be switched of before drawing into the screens bitmap. This function has no effect on cards offering a hardwaremouse. Calls to E_MouseOn() and E_MouseOff() may be nested. This function should not be used to hide the mouse for optical reasons, because it has no effects on cards with a hardware mouse. You should use E_ModifyEMouse(). Not moving the mouse several seconds and calling E_MouseOff() results in not turning the mouse on again at the corresponding E_MouseOn(). The pointer reappears as soon as the mouse is moved. E_MouseOff() and E_MouseOn() are nestable so that for complex drawing there is no need to turn on and off the mouse for each element, i.e. nesting is applicable without any complications. Each E_MouseOff() must be accompanied by a corresponding E_MouseOn(). As functions of the egsblit.library they have no information, if a screen is attached to their bitmap then they make no calls to E_MouseOn() E_MouseOff(). But as the functions in the egsgfx.library they are working on a rastport. They know which bitmap is associated with a screen, they make calls to E_MouseOff() E_MouseOn(). INPUTS scr - the screen where you intend to draw into RESULT SEE ALSO E_MouseOn(), E_MouseOffRect() egs.library/E_MouseOffRect egs.library/E_MouseOffRect NAME E_MouseOffRect -- switch softwaremouse in rectangle off SYNOPSIS E_MouseOffRect(scr, rect) A0 A1 void E_MouseOffRect(E_EScreenPtr, E_ClipRectPtr) FUNCTION Defines a rectangular region of a screen as a mouse off region. If the mouse is located inside or is moved into the region, the software mouse cursor is turned off. The mouse is turned on by E_MouseOn(). Several nested calls of E_MouseOffRect() will result in a mouse off region, that is the bounding box of all small regions. INPUTS scr - the screen where you intend to draw into rect - the rectangle where you intend to draw into RESULT SEE ALSO E_MouseOn(), E_MouseOff() egs.library/E_MouseOn egs.library/E_MouseOn NAME E_MouseOn -- Switch software mouse on SYNOPSIS E_MouseOn(scr) A0 void E_MouseOn(E_EScreenPtr) FUNCTION Switches a software mouse on again. See E_MouseOff(). INPUTS scr - the screen where you switched the mouse off RESULT SEE ALSO E_MouseOff(), E_MouseOffRect() egs.library/E_MoveMouse egs.library/E_MoveMouse NAME E_MoveMouse -- move the mousecursor on a screen SYNOPSIS E_MoveMouse(scr, x, y) A0 D0 D1 void E_MoveMouse(E_EScreenPtr, WORD, WORD) FUNCTION Moves the mousecursor to a particular location on the screen. NOTE It is not guaranteed, that this call will actually move the mouse, but it will do so in most cases, just do not rely on it. This call will also result in an EDCMP message to the screens port. INPUTS scr - the screen where the mouse shall be move x - horizontal destination location y - vertical RESULT SEE ALSO E_ModifyMouse(), E_ScreenToFront(), E_SetUserFocus() egs.library/E_NewMapType egs.library/E_NewMapType NAME E_NewMapType -- calculate a new bitmap type SYNOPSIS E_NewMapType() ULONG E_NewMapType(void) FUNCTION If you create a bitmap class, that is totaly different from all public bitmap classes, you have to get the bitmap type by calling this function. It will return a unique bitmap type id. INPUTS RESULT a new bitmap type id, or 0 if none is free SEE ALSO E_CreateSubClass(), "includes/egs/egs.h" egs.library/E_ObtainClass egs.library/E_ObtainClass NAME E_ObtainClass -- obtain a class SYNOPSIS E_ObtainClass(class) A0 void E_ObtainClass(E_EGSClassPtr) FUNCTION Obtains a class for use. This guarantees, that the class is not deleted, until you release it again. Each call of E_ObtainClass() should have an associated E_ReleaseClass(). INPUTS class - the class you want to obtain RESULT SEE ALSO E_ReleaseClass(), E_ObtainPublicObject(), ObtainPublicClass() egs.library/E_ObtainMonitorSpec egs.library/E_ObtainMonitorSpec NAME E_ObtainMonitorSpec -- obtain a monitor spec by its name SYNOPSIS E_ObtainMonitorSpec(name) A0 E_MonitorSpecPtr E_ObtainMonitorSpec(char *) FUNCTION Obtains a monitor spec for your use. If the spec is not yet resident in the system, it is loaded from the "egs:monitors/specs" directory. You should call E_ReleaseMonitorSpec(), when you are done with it, to allow the system to remove it. INPUTS name - the name of the monitor spec RESULT your desired monitor spec, or NULL if this failed SEE ALSO E_ReleaseMonitorSpec(), E_CreateMonitorSpecTags() egs.library/E_ObtainObject egs.library/E_ObtainObject NAME E_ObtainObject -- obtain an object SYNOPSIS E_ObtainObject(obj) A0 void E_ObtainObject(E_PublicEGSObjectPtr) FUNCTION Obtains an object, so that it is protected from deletion until you release it again. This can only be done with objects that are of a subclass of the public object class. INPUTS obj - the object you want to obtain RESULT SEE ALSO E_ReleaseObject(), E_ObtainPublicObject() egs.library/E_ObtainObjectClass egs.library/E_ObtainObjectClass NAME E_ObtainObjectClass -- obtain the class of an object SYNOPSIS E_ObtainObjectClass(obj) A0 E_EGSClassPtr E_ObtainObjectClass(E_EGSObjectPtr) FUNCTION Obtains the class of an object. If you are done with the class, you should release it with E_ReleaseClass(). INPUTS obj - the object you want to get the class RESULT a pointer to the objects class SEE ALSO E_ObtainClass(), E_ObtainPublicClass(), E_ReleaseClass() egs.library/E_ObtainPublicClass egs.library/E_ObtainPublicClass NAME E_ObtainPublicClass -- obtain a class by its name SYNOPSIS E_ObtainPublicClass(name) D0 E_EGSClassPtr E_ObtainPublicClass(E_Symbol) FUNCTION Looks for a class with the given name and obtains it. If the class isn't already resident in the system, the library attempts to load it from disk ("egs:egsclasses"). It will look for a file with the name of the class. This file can be either an EGS driver implementing the class, or a reference to a driver that implements a group of classes. ### INPUTS name - a symbol for the name of the class RESULT the pointer to the desired class, or NULL if it was not found. SEE ALSO E_ObtainClass(), E_ReleaseClass() egs.library/E_ObtainPublicObject egs.library/E_ObtainPublicObject NAME E_ObtainPublicObject -- obtains a public object SYNOPSIS E_ObtainPublicObject(name) D0 E_PublicEGSObjectPtr E_ObtainPublicObject(E_Symbol) FUNCTION Looks for a public object with the given name, and obtains it. INPUTS name - a symbol given by the name of the object RESULT a pointer to the object, or NULL if it was not in the public dictionary. SEE ALSO E_ObtainObject(), E_ReleaseObject() egs.library/E_ObtainScreenSpec egs.library/E_ObtainScreenSpec NAME E_ObtainScreenSpec -- obtain a screen spec SYNOPSIS E_ObtainScreenSpec(moni, name) A0 A1 E_ScreenSpecPtr E_ObtainScreenSpec(E_MonitorSpecPtr, char *) FUNCTION Exclusively obtains a screen spec structure, so it is protected from foreign modification. INPUTS moni - the monitor the screen spec belongs to name - the name of the screen spec RESULT a pointer to the screen spec structure SEE ALSO E_ReleaseScreenSpec(), E_ObtainMonitorSpec() egs.library/E_OldWaitTOF egs.library/E_OldWaitTOF NAME E_OldWaitTOF -- obsolete SYNOPSIS E_OldWaitTOF() void E_OldWaitTOF(void) FUNCTION INPUTS RESULT SEE ALSO egs.library/E_OpenScreen egs.library/E_OpenScreen NAME E_OpenScreen -- Open a screen SYNOPSIS E_OpenScreen(scr) A0 E_EScreenPtr E_OpenScreen(struct E_NewEScreen *) FUNCTION Opens a screen on a graphics board. This function allocates the bitmap, initializes a port if needed, and forces the video logic to display this screen. See also egsintui.library/EI_OpenScreen. This type of screen is not able to have windows or layers. The function requires an initialized E_NewScreen structure, that may be discarded afterwards. If an port is supplied this port has to be removed, before the screen is closed, or the message flags are set to none. The library creates an own port, if NULL is passed. INPUTS new - Inizialised E_NewScreen structure RESULT An opened screen if successfull else NULL. Reasons for failure may be unknown mode, not enough memory or unsupported depth. SEE ALSO E_OpenScreenTagList(), E_CloseScreen() egs.library/E_OpenScreenTagList egs.library/E_OpenScreenTagList NAME E_OpenScreenTagList -- extended open screen SYNOPSIS E_OpenScreenTagList(nscr, tags) A0 A1 E_EScreenPtr E_OpenScreenTagList(E_NewEScreenPtr, APTR) FUNCTION Opens a screen with additional parameters passed as a tag list. INPUTS nscr - NULL or an E_NewEScreen structure tags - modifying tags (see "includes/egs/egs.h EST_...) RESULT am open screen, or NULL if failed to open SEE ALSO E_OpenScreen(), E_CloseScreen() egs.library/E_ReleaseClass egs.library/E_ReleaseClass NAME E_ReleaseClass -- release a class SYNOPSIS E_ReleaseClass(class) A0 void E_ReleaseClass(E_EGSClassPtr) FUNCTION Releases a class that was obtained by E_ObtainClass(), E_ObtainObjectClass(), E_ObtainPublicClass(). You may not use the class anymore after you released it. INPUTS class - the class to release RESULT SEE ALSO E_ObtainClass(), E_ObtainObjectClass(), E_ObtainPublicClass(), E_ReleasePublicObject() egs.library/E_ReleaseMonitorSpec egs.library/E_ReleaseMonitorSpec NAME E_ReleaseMonitorSpec -- release a monitor spec SYNOPSIS E_ReleaseMonitorSpec(moni) A0 void E_ReleaseMonitorSpec(E_MonitorSpecPtr) FUNCTION Releases a monitor spec, that was obtained by E_ObtainMonitorSpec(). You may not access the structure after you released it. INPUTS moni - the monitor structure to release RESULT SEE ALSO E_ObtainMonitor(), E_ReleaseScreenSpec() egs.library/E_ReleasePublicObject egs.library/E_ReleasePublicObject NAME E_ReleasePublicObject -- release a public object SYNOPSIS E_ReleasePublicObject(obj) A0 void E_ReleasePublicObject(E_PublicEGSObjectPtr) FUNCTION Releases a public object that was obtained by E_ObtainObject() or E_ObtainPublicObject(). You may not use the object after you released it. INPUTS obj - the object to release RESULT SEE ALSO E_ObtainPublicObject(), E_ObtainObject(), E_ReleaseClass() egs.library/E_ReleaseScreenSpec egs.library/E_ReleaseScreenSpec NAME E_ReleaseScreenSpec -- releases a screen spec structure SYNOPSIS E_ReleaseScreenSpec(spec) A0 void E_ReleaseScreenSpec(E_ScreenSpecPtr) FUNCTION Releases a screen spec structure back to public use. INPUTS spec - the screen spec you had exclusively RESULT SEE ALSO E_ReleaseMonitorSpec(), E_ObtainScreenSpec() egs.library/E_ReloadPrefs egs.library/E_ReloadPrefs NAME E_ReloadPrefs -- reload preference files SYNOPSIS E_ReloadPrefs() void E_ReloadPrefs(void) FUNCTION Reloads the EGS preferences files again, to represent the changes that where made. INPUTS RESULT SEE ALSO egs.library/E_RemMonitorSpec egs.library/E_RemMonitorSpec NAME E_RemMonitorSpec -- remove a monitor spec from a driver SYNOPSIS E_RemMonitorSpec(driver, moni) A0 A1 void E_RemMonitorSpec(E_DisplayDriverPtr, E_MonitorSpecPtr) FUNCTION Removes a monitor spec from a driver. The driver will loose all screenmodes that where defined by this monitor specification. INPUTS driver - the driver you want to remove from moni - the spec you want to remove RESULT SEE ALSO E_AddMonitorSpec(), E_ObtainMonitorSpec(), E_DeleteMonitorSpec() egs.library/E_RemVideoLink egs.library/E_RemVideoLink NAME E_RemVideoLink -- remove a link between video nodes SYNOPSIS E_RemVideoLink(from, to) A0 A1 void E_RemVideoLink(E_VideoNodePtr, E_VideoNodePtr) FUNCTION Removes a link between video node, that has previously be created by E_AddVideoLink(). INPUTS from - the source of the link to - the drain of the link RESULT SEE ALSO E_AddVideoLink(), E_FindPublicVideoNode() egs.library/E_RenameMonitorSpec egs.library/E_RenameMonitorSpec NAME E_RenameMonitorSpec -- rename a monitor spec SYNOPSIS E_RenameMonitorSpec(moni, name) A0 A1 void E_RenameMonitorSpec(E_MonitorSpecPtr, char *) FUNCTION Renames a monitor spec to a new name. The name of the associated disk file is also changed. INPUTS moni - the monitor spec to rename name - the new name of the structure RESULT SEE ALSO E_CreateMonitorSpecTagList(), E_DeleteMonitorSpec() egs.library/E_ResetMouseExcept egs.library/E_ResetMouseExcept NAME E_ResetMouseExcept -- remove an installed mouse except SYNOPSIS E_ResetMouseExcept() void E_ResetMouseExcept(void) FUNCTION INPUTS RESULT BUGS This is private ! SEE ALSO egs.library/E_SaveMonitorPrefs egs.library/E_SaveMonitorPrefs NAME E_SaveMonitorPrefs -- save the monitor prefs of a driver SYNOPSIS E_SaveMonitorPrefs(driver) A0 void E_SaveMonitorPrefs(E_DisplayDriverPtr) FUNCTION Saves the monitor preferences of a display driver to disk. This file contains references to monitor spec files, and will be used to build the screenmodes of the driver. INPUTS driver - the driver to save its prefs RESULT SEE ALSO E_LoadMonitorPrefs(), E_AddMonitorSpec(), E_RemMonitorSpec() egs.library/E_SaveMonitorSpec egs.library/E_SaveMonitorSpec NAME E_SaveMonitorSpec -- save a monitor spec to disk SYNOPSIS E_SaveMonitorSpec(moni) A0 void E_SaveMonitorSpec(E_MonitorSpecPtr) FUNCTION Saves a monitor spec structure to disk ("egs:monitors/specs"). INPUTS moni - the monitor spec to save RESULT SEE ALSO E_ObtainMonitorSpec(), E_RenameMonitorSpec(), E_DeleteMonitorSpec() egs.library/E_ScreenToBack egs.library/E_ScreenToBack NAME E_ScreenToBack -- Moves a screen behind all others SYNOPSIS E_ScreenToBack(scr) A0 void E_ScreenToBack(E_EScreenPtr) FUNCTION Moves a screen behind all other screens of its monitor. Shows the next screen, if there are more then one. INPUTS scr - the screen to rearrange RESULT SEE ALSO E_ScreenToFront(), E_SetUserFocus() egs.library/E_ScreenToFront egs.library/E_ScreenToFront NAME E_ScreenToFront -- Moves a screen to front SYNOPSIS E_ScreenToFront(scr) A0 void E_ScreenToFront(E_EScreenPtr) FUNCTION Moves a screen in front of all other screens of its monitor, and displays the screen. This action may require several milliseconds, and may have flicker effects on the screen. For double buffering you should use E_FlipMap() instead. If you want to activate the screen, you should call E_SetUserFocus(). INPUTS scr - pointer to the screen RESULT SEE ALSO E_ScreenToBack(), E_SetUserFocus() egs.library/E_SendEGSMsg egs.library/E_SendEGSMsg NAME E_SendEGSMsg -- send an EGS message SYNOPSIS E_SendEGSMsg(scr, x, y, class, code, qualifier, seconds, micros, doubleDead) A0 D0 D1 D2 D3 D4 D5 D6 D7 void E_SendEGSMsg(E_EScreenPtr, WORD, WORD, ULONG, UWORD, ULONG, ULONG, ULONG, LONG) FUNCTION Sends an EDCMP message to the port of a screen. This function is usefull for display driver implentor, that want to take controll over the mouse and other input streams. INPUTS scr - the screen you control x - x location of mouse y - y location of mouse class - edcmp flags code - code field of input event qualifier - key/mouse qualifiers seconds - time stamp micros - doubleDead - double dead key block RESULT SEE ALSO E_MoveMouse(), E_ModifyEDCMP() egs.library/E_SetMouseExcept egs.library/E_SetMouseExcept NAME E_SetMouseExcept -- SYNOPSIS E_SetMouseExcept(callMe, data) A0 A1 void E_SetMouseExcept(APTR, APTR) FUNCTION INPUTS callMe - data - RESULT BUGS this one should be private SEE ALSO egs.library/E_SetRGB8 egs.library/E_SetRGB8 NAME E_SetRGB8 -- Modify an entry in a screens clut SYNOPSIS E_SetRGB8(scr, reg, red, green, blue) A0 D0 D1 D2 D3 void E_SetRGB8(E_EScreenPtr, UWORD, UWORD, UWORD, UWORD) FUNCTION Modifies an entry in a screens color look up table. This should only be done in pseudo color modes, which have a look up table. In real color modes this modifies the gamma correction table. This function may wait for a screen blank, so do not use it to modify large areas of a clut, use E_SetRGB8CM(). Depending on the screens bit depth up to 256 registers can be used. In 24 bit mode the CLUT may serve as gamma correction (see hardinfo flags). INPUTS reg - register number to modify red, green, blue - Color values RESULT SEE ALSO E_SetRGB8CM(), E_GetRGB8(), E_GetRGB8CM() egs.library/E_SetRGB8CM egs.library/E_SetRGB8CM NAME E_SetRGB8CM -- Mofify several entries in a screens clut SYNOPSIS E_SetRGB8CM(scr, colors, start, num) A0 A1 D0 D1 void E_SetRGB8CM(E_EScreenPtr, E_CLUPtr, WORD, WORD) FUNCTION Copies a part of a color look up table in the screens clut. This function should be used, if there are several changes in a clut. It can take some time, because it updates all registers. So if there are changes at different areas in the clut, you should use E_GetRGB8CM() to get the full palette, then modify and E_SetRGB8CM() them back to the screen. You should not use this function to just make one change. The sum of start and num mey not exceed the number of available color registers. INPUTS colors - buffer from which to take the colors start - first register to modify num - number of registers to modify RESULT SEE ALSO E_SetRGB8(), E_GetRGB8(), E_GetRGB8CM() egs.library/E_SetUserFocus egs.library/E_SetUserFocus NAME E_SetUserFocus -- define the active screen SYNOPSIS E_SetUserFocus(scr) A0 void E_SetUserFocus(E_EScreenPtr) FUNCTION This function attempts to make your screen the active one. It will put it to front, and also puts the mouse onto it. You should use this call very carefully, it might confuse the user, to loose his mouse cursor.. INPUTS scr - the screen to become the active one RESULT SEE ALSO E_CrossMouseBorder(), E_ScreenToFront() egs.library/E_UnlockEGSVideo egs.library/E_UnlockEGSVideo NAME E_UnlockEGSVideo -- unlock the EGS display system SYNOPSIS E_UnlockEGSVideo() void E_UnlockEGSVideo(void) FUNCTION Unlocks the EGS display system, see E_LockEGSVideo() INPUTS RESULT SEE ALSO E_LockEGSVideo() egs.library/E_WaitTOF egs.library/E_WaitTOF NAME E_WaitTOF -- Wait for TOF SYNOPSIS E_WaitTOF(scr) A0 void E_WaitTOF(E_EScreenPtr) FUNCTION Sets the calling task to wait, until a vertical blank interrupt occurs. To be shure to get the cpu in the VBlank you should change your task priority to a high level. If the used graphicsboard does not support an vertical blank interrupt (see E_HardInfo) this call will have no effect and will return immediately. INPUTS scr - the screen, to wait on vertical blank RESULT SEE ALSO egs.library/E_WhichMonitor egs.library/E_WhichMonitor NAME E_WhichMonitor -- find a screens monitor SYNOPSIS E_WhichMonitor(scr) A0 E_MonitorPtr E_WhichMonitor(E_EScreenPtr) FUNCTION Determines the monitor a screen is currently displayed on. If the screen is displayed on more than one monitor, you will get the first one in the list. INPUTS scr - the screen to look for RESULT a pointer to the monitor, or NULL if the screen is not currently displayed. SEE ALSO E_WhichScreen(), E_LinkVideoNodes() egs.library/E_WhichScreen egs.library/E_WhichScreen NAME E_WhichScreen -- find a monitors screen SYNOPSIS E_WhichScreen(moni) A0 E_EScreenPtr E_WhichScreen(E_MonitorPtr) FUNCTION Determines the screen, that is currently displayed on this monitor. INPUTS moni - the monitor to look for RESULT a pointer to the screen, or NULL if no screen is currently displayed on the monitor SEE ALSO E_WhichMonitor(), E_LinkVideoNodes() egs.library/E_isSubClass egs.library/E_isSubClass NAME E_isSubClass -- checks if a class is a subclass SYNOPSIS E_isSubClass(class, of) A0 A1 BOOL E_isSubClass(E_EGSClassPtr, E_EGSClassPtr) FUNCTION Checks if a class is a subclass of an other class. INPUTS class - the subclass of - the superclass RESULT TRUE if class is a subclass of of SEE ALSO E_isSubType(), E_CreateSubClass() egs.library/E_isSubType egs.library/E_isSubType NAME E_isSubType -- checks if an object is of a specific class SYNOPSIS E_isSubType(obj, of) A0 A1 BOOL E_isSubType(E_EGSObjectPtr, E_EGSClassPtr) FUNCTION Checks if an objects class is a subclass of an other class. INPUTS obj - the object to check of - the subclass RESULT TRUE if the objects class is a subclass, FALSE else SEE ALSO